Configuring a Process+ Action Object

Configure an Action Object by defining the Action Object name and the loop configuration information file, selecting a data source for loop data, and selecting the reporting periods required.

Deployment configuration

Action Object name

Provide a custom name for the Action Object.
Each Action Object deployed must have a unique name.

Loop definitions file

Click on the [...] ellipsis button to browse to the correct loop definitions file.
This file has a .csv file extension.
Sampling period (seconds): this will be automatically populated by the sampling period defined in the loop definitions file.
Number of loops: this will be automatically populated by the information in the loop definitions file.

For more information, see Loop Definition File.

Histogram bins

Define the number of bins to be calculated for Control Loop KPIs.

Data source

Select a data source for loop tag data.

There are two types of sources for loop data: historical sources and real-time sources.
Select the correct data source using the radio buttons, and the drop down menus.
Note that is for the loop data, not the loop configuration information found in the loop definitions .csv file.
Each Action Object configured can read data from only one data source.
Each Action Object configured can read data from a different data source.
Read more on data sources for Process+ Action Objects.

Reporting period selection

Select the shift/s for which you want Process+ KPIs generated by checking the relevant boxes. Check as many boxes as required.

Shift start times and durations are configured through the Schedule Manager that is launched by clicking on the Manage Schedules button.
For more information see the Schedule Manager page.
Also read more about Reporting period and Daylight Savings Time.

Note the following conditions for different Action Object types, and for different data sources:

KPI Schedules for real-time data sources

Process+ KPIs are generated after the 1st shift, as data needs to be collected for statistical calculations.
Process+ KPIs are calculated after each shift, as per your Action Object configuration.
The statistics are calculated continuously on real-time data sources, until the shift is completed and the Process+ KPIs are generated.
The longest shift possible is the 24 hours day shift.

KPI Schedules for historical data sources

Process+ KPIs are generated after the 1st day.
The statistics are calculated only once in Action Objects using historical sources - at the end of each day, when a complete 24 hour period has passed.
It is not possible to calculate statistics on shifts occurring before the previous 24 hours.
The longest shift possible is the 24 hours day shift.

Ad hoc KPI Schedules (for historical data sources)

Ad hoc Process+ KPIs use historical data.
The statistics are calculated only once in Action Objects using historical sources - at the end of each day, when a complete 24 hour period has passed.
Select the window period dates to start collecting data for the ad hoc Process+ KPIs, from the start of the first KPI schedule to the end of the last KPI schedule.
The shift start time for the selected reporting periods will have previously been defined in the system properties. Example:
- if the shift start time = 02h00
- and the first KPI schedule time is set to 02h00,
- the returned reporting period is [02h00 (day 1, inclusive) to 02h00 (day 2, exclusive))
Example

Let us define three shifts, then compare when Process+ KPIs will be generated for real-time vs historical data.
Example 1
Shift 1 (S1): 00:00 - 08:00
Shift 2 (S2): 08:00 - 16:00
Shift 3 (S3): 16:00 - 00:00

KPI Schedules for real-time data sources:

The Process+ KPIs are calculated at the end of a shift. Therefore, on Day 1, when the time passes 08:00, the Process+ KPIs executes and calculates data for Day 1 Shift 1 (D1S1). The same applies for D1S2: when the time passes 16:00, the data for Day 1 Shift 2 (D1S2) will be available.

At the end of Day 1, which is actually 00:00 on Day 2, the data for D1Day and D1S3 will be calculated for Day 1.

KPI Schedules for historical data sources:

The KPI schedule for all the shifts and the daily schedule are only calculated at the end of the day. This means that Day 1's Process+ KPIs (D1S1, D1S2, D1S3 and D1Day) will only be available at 00:00 on Day 2 (which is the end of Day 1).

Example 2

Let's define the shift times differently:

Shift 1 (S1): 04:00 - 12:00
Shift 2 (S2): 12:00 - 20:00
Shift 3 (S3): 20:00 - 04:00

KPI Schedules for real-time data sources:

As in Example 1, the Process+ KPIs are calculated at the end of a shift. Therefore, on Day 1, when the time passes 12:00, the Process+ KPIs execute and calculates data for Day 1 Shift 1 (D1S1). The same applies for D1S2: when the time passes 20:00, the data for Day 1 Shift 2 (D1S2) will be available.

At the end of Day 1, which is actually 04:00 the following day, the data for D1Day and D1S3 will be calculated for Day 1.

KPI Schedules for historical data sources:

As in Example 1, the KPI schedule for all the shifts and the daily schedule are only calculated at the end of the day. This means that Day 1's Process+ KPIs (D1S1, D1S2, D1S3 and D1Day) will only be available at 04:00 on the following day.

Note: A DAY schedule is not confined to the 24 hour clock, from midnight to midnight. Rather it is a 24 hour period, with a defined start and end time, and is the duration of all the shifts adding up to a 24 hour period.